/*
 * Copyright Red Hat Inc. and/or its affiliates and other contributors
 * as indicated by the authors tag. All rights reserved.
 *
 * This copyrighted material is made available to anyone wishing to use,
 * modify, copy, or redistribute it subject to the terms and conditions
 * of the GNU General Public License version 2.
 * 
 * This particular file is subject to the "Classpath" exception as provided in the 
 * LICENSE file that accompanied this code.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT A
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License,
 * along with this distribution; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA  02110-1301, USA.
 */
package org.eclipse.ceylon.ant;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/** 
 * Annotation on ant attribute setter/adder which is 
 * equivalent to an option of a {@code ceylon} CLI tool.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD) 
public @interface OptionEquivalent {
    /** 
     * The full long-option name (e.g. {@code --foo-bar} of 
     * the corresponding option. If empty the long option name will 
     * be inferred from the name of the annotated method via
     * camel-case to dashed conversion.
     */
    String value() default "";
    
    /**
     * Whether to link to the option in the tool's documentation 
     */
    boolean link() default true;
    
    /**
     * Whether to transclude the option documentation from the tool's documentation
     */
    boolean transclude() default true;
}